Setting general connection properties

This section describes how to configure general connection properties. For an explanation of how to configure advanced connection properties, see Setting advanced connection properties.

To define the general connection properties:

1. Click the Manage Endpoint Connections toolbar button.

   The Manage Endpoints Connections dialog box opens.

2. Click the New Endpoint Connection toolbar button.

   The Name, Description, Type and Role fields are displayed on the right.

3. In the Name field, specify a display name for the endpoint.
4. In the Description field, optionally type a description for the Microsoft Azure Event Hubs endpoint.
5. Select Target as the endpoint Role.

6. Select Microsoft Azure Event Hubs as the endpoint Type.

   The dialog box is divided into General and Advanced tabs.

7. In the Access Details section, set the following properties:

   • Namespace: Enter the name of your Event Hubs namespace.

     Example: eventhubdemo

     Information note

     To connect to an Azure resource on Government Cloud or China Cloud, you need to specify the full resource name of the namespace, which is the name plus the suffix. For instance, assuming the namespace name is eventhubdemo, then the full resource name for a public resource would be eventhubdemo.servicebus.windows.net. For Government Cloud or China Cloud, the format should be the same but with the Government Cloud or China Cloud suffix instead.

      

     For information on setting internal parameters, see Setting advanced connection properties

   • Authentication: Select one of the following authentication types and provide values accordingly.

     • Shared Access Policy: Provide the following values:

       • Shared Policy Name: Enter the name of your shared access policy.

         Example: RootManageSharedAccessKey

       • Shared Access Key: Enter your shared access primary or secondary key.

         Example: BZLreXGxiWiRpGAog9Zf6b3K7ycRsImfBWqsR+SJp34=

     • Azure Active Directory Service Principal: Provide values for the Azure Active Directory Tenant ID, Application Registration Client ID, and Application Registration Secret fields

     • Azure Active Directory Managed Identity

8. In the Message Properties section, select either JSON or Avro as the message format.

   Information note

   Qlik provides an Avro Message Decoder SDK for consuming Avro messages produced by Qlik Replicate. You can download the SDK as follows:

   1. Go to Product Downloads.

   2. Select Qlik Data Integration.

   3. Scroll down the Product list and select Replicate.

   4. In the Download Link column, locate the QlikReplicate_<version>_Avro_Decoder_SDK.zip file. Before starting the download, check the Version column to make sure that the version correlates with the Replicate version you have installed.

   5. Proceed to download the QlikReplicate_<version>_Avro_Decoder_SDK.zip file.

   For usage instructions, see Kafka Avro consumers API.

   An understanding of the Qlik envelope schema is a prerequisite for consuming Avro messages produced by Qlik Replicate. If you do not wish to use the SDK, see The Qlik Envelope for a description of the Qlik envelope schema.

9. In the Data Message Publishing section, set the following properties:

   1. In the Publish the data to field, choose one of the following:

      • Specific hub - to publish the data to a single hub. Either type a hub name or use the browse button to select the desired hub.

      • Separate hub for each table - to publish the data to multiple hubs corresponding to the source table names. If you select this option, the hub name format must be as described in the prerequisites.

        Information note

        Microsoft Azure Event Hubs supports a maximum of ten hubs, which includes hubs that are required for storing Replicate Control Table data. At least one of the ten hubs must be set aside for the mandatory attrep_apply_exceptions Control Table, leaving nine hubs to which source data can be published (providing that no other Control Tables are set).

        The target hub name consists of the source schema name and the source table name, separated by a period (e.g. "dbo.Employees"). The format of the target hub name is important as you will need to prepare these hubs in advance.

   2. From the Partition strategy drop-down list, field, select either Random or By message key. If you select Random, each message will be written to a randomly selected partition. If you select By message key, messages will be written to partitions based on the selected Message key (described below).

   3. From the Message key drop-down list, field, select one of the following:

      Information note

      Note  The message key is represented as a string, regardless of the selected data message format (JSON/Avro).

      • Schema and table name - For each message, the message key will contain a combination of schema and table name (e.g. "dbo+Employees").

        When By message key is selected as the Partition strategy, messages consisting of the same schema and table name will be written to the same partition.

      • Primary key columns - For each message, the message key will contain the value of the primary key column.

        When By message key is selected as the Partition strategy, messages consisting of the same primary key value will be written to the same partition.

10. In the Metadata Message Publishing section, specify whether or where to publish the message metadata.

    From the Publish drop-down list, select one of the following options:

    • Do not publish metadata messages - When this option is selected, only data messages will be published.

    • Publish metadata messages to a dedicated metadata hub

      If you select this option, either type the Hub name or use the Browse button to select the desired hub.

      Information note

      It is strongly recommended not to publish metadata messages to the same stream as data messages.